<!-- .\" $Id: papi_enum_event.html,v 1.3.12.1 2006/11/02 21:25:22 terpstra Exp $ -->
<!-- .TH PAPI_enum_event 3 "October, 2006" "PAPI Programmer's Reference" "PAPI" -->
<HTML>
<HEAD>
<TITLE>
Manual Page - PAPI_enum_event(3)</TITLE>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">

<STYLE TYPE="text/css">

<!--

p

{font-family: Verdana, Helvetica, Arial, sans-serif}



.style

{font-family: Verdana, Helvetica, Arial, sans-serif}



td.navBar A:link

{color: #ddd8d2;

font-weight: bold;

text-decoration: none}



td.navBar A:visited

{color: #ccc9c5;

font-weight: bold;

text-decoration: none}



td.navBar A:hover

{color: #ffffff}



.navBar

{color: #77797c;

font-family: Verdana, Helvetica, Arial, sans-serif;

font-size:  11px;

text-transform: uppercase}



a:visited

{color: #50525f}



a:link

{color: #8b3409}



a:hover

{color: #660000}



a:active

{background-color: #b1afad}



.footerNote

{background-color: #ffffff;

background-image: url(../images/line.gif);

background-position: right top;

background-repeat: repeat-x;

color: #77797c;

font-family: Verdana, Helvetica, Arial, sans-serif;

font-size:  10px}



BODY

{font-family: Verdana, Helvetica, Arial, sans-serif}

-->

</STYLE> <SCRIPT LANGUAGE="JavaScript">

<!--

function MM_swapImgRestore() { //v3.0

  var i,x,a=document.MM_sr; for(i=0;a&&i<a.length&&(x=a[i])&&x.oSrc;i++) x.src=x.oSrc;

}



function MM_preloadimages() { //v3.0

  var d=document; if(d.images){ if(!d.MM_p) d.MM_p=new Array();

    var i,j=d.MM_p.length,a=MM_preloadimages.arguments; for(i=0; i<a.length; i++)

    if (a[i].indexOf("#")!=0){ d.MM_p[j]=new Image; d.MM_p[j++].src=a[i];}}

}



function MM_findObj(n, d) { //v4.0

  var p,i,x;  if(!d) d=document; if((p=n.indexOf("?"))>0&&parent.frames.length) {

    d=parent.frames[n.substring(p+1)].document; n=n.substring(0,p);}

  if(!(x=d[n])&&d.all) x=d.all[n]; for (i=0;!x&&i<d.forms.length;i++) x=d.forms[i][n];

  for(i=0;!x&&d.layers&&i<d.layers.length;i++) x=MM_findObj(n,d.layers[i].document);

  if(!x && document.getElementById) x=document.getElementById(n); return x;

}



function MM_swapImage() { //v3.0

  var i,j=0,x,a=MM_swapImage.arguments; document.MM_sr=new Array; for(i=0;i<(a.length-2);i+=3)

   if ((x=MM_findObj(a[i]))!=null){document.MM_sr[j++]=x; if(!x.oSrc) x.oSrc=x.src; x.src=a[i+2];}

}

//-->

</SCRIPT> 

</HEAD>

<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LEFTMARGIN="0" TOPMARGIN="0" MARGINWIDTH="0" MARGINHEIGHT="0">

<TABLE WIDTH="101%" BORDER="0" CELLSPACING="0" CELLPADDING="0">

<TR>

<TD VALIGN="top" HEIGHT="75">

<TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" HEIGHT="75">

<TR>

<TD BACKGROUND="../images/menubg95.jpg" HEIGHT="75">

<TABLE WIDTH="760" BORDER="0" CELLSPACING="0" CELLPADDING="0" ALIGN="center" HEIGHT="75">

<TR VALIGN="bottom">

<TD WIDTH="760" ALIGN="center" HEIGHT="50" COLSPAN="2">

<IMG SRC="../images/headertop.jpg" WIDTH="760" HEIGHT="50"></TD>

</TR>

<TR>

<TD HEIGHT="10" ALIGN="center" VALIGN="top" BGCOLOR="#333333" WIDTH="135">

<IMG SRC="../images/logoleft.jpg" WIDTH="135" HEIGHT="25" VSPACE="0" HSPACE="0" ALIGN="left">

</TD>

<TD CLASS="navBar" HEIGHT="25" ALIGN="center" VALIGN="middle" BGCOLOR="#333333" NOWRAP WIDTH="625" BACKGROUND="../images/menubg.jpg">

<CENTER>

<A HREF="http://icl.cs.utk.edu/papi/">

PAPI HOME

</A>

</CENTER>

</TD>

</TR>

<TR>

<TD HEIGHT="10" ALIGN="center" VALIGN="top" BGCOLOR="FFFFFF" WIDTH="135">

<IMG SRC="../images/logobottom.jpg" WIDTH="135" HEIGHT="20" VSPACE="0" HSPACE="0" ALIGN="left">

</TD>

<TD CLASS="navBar" HEIGHT="10" ALIGN="center" VALIGN="bottom" BGCOLOR="FFFFFF" WIDTH="625">

<IMG SRC="../images/white.jpg" WIDTH="625" HEIGHT="20" VSPACE="0" HSPACE="0" ALIGN="left">

</TD>

</TR>

</TABLE>

</TD>

</TR>

</TABLE>

</TD>

</TR>

<TR>

<TD VALIGN="top">

<TABLE WIDTH="760" BORDER="0" CELLSPACING="0" CELLPADDING="0" ALIGN="center" CLASS="style">

<TR>

<TD CLASS="STYLE">

<P>
<!-- .SH NAME -->
<A name=0>

     <H3>NAME</H3>

</A>
<BLOCKQUOTE>
<!-- .nf -->
<PRE>
PAPI_enum_event - enumerate PAPI preset or native events
<!-- .fi -->
</PRE>
<P>
<!-- .SH SYNOPSIS -->
</BLOCKQUOTE>
<A name=contents></A><H3>CONTENTS</H3></A>
<BLOCKQUOTE>
<A HREF=#1>Synopsis</A><BR>
<A HREF=#2>Description</A><BR>
<A HREF=#3>Arguments</A><BR>
<A HREF=#4>Pentium 4</A><BR>
<A HREF=#5>Itanium</A><BR>
<A HREF=#6>Power 4</A><BR>
<A HREF=#7>Return Values</A><BR>
<A HREF=#8>Errors</A><BR>
<A HREF=#9>Examples</A><BR>
<A HREF=#10>Bugs</A><BR>
<A HREF=#11>See Also</A><BR>
</BLOCKQUOTE>
<A name=12>

     <H3>SYNOPSIS</H3>

</A>
<BLOCKQUOTE>
<!-- .B C Interface -->
<B>C Interface</B> <!-- .nf -->
<PRE>
<!-- .B #include <papi.h> -->
<B>#include &lt;papi.h&gt;</B> 
<!-- .BI "int PAPI_enum_event(int " *EventCode, "int " modifer ");" -->
<B>int PAPI_enum_event(int </B><I>*EventCode,</I><B>int </B><I>modifer</I><B>);</B> 
<!-- .fi -->
</PRE>
<!-- .B Fortran Interface -->
<B>Fortran Interface</B> <!-- .nf -->
<PRE>
<!-- .B #include "fpapi.h" -->
<B>#include fpapi.h</B> 
<!-- .BI PAPIF_enum_event(C_INT\  EventCode,\  C_INT\  modifier ,\  C_INT\  check ) -->
<B>PAPIF_enum_event(C_INT </B><I>EventCode, </I><B>C_INT </B><I>modifier</I><B>, </B><I>C_INT </I><B>check</B><I>)</I> 
<!-- .fi -->
</PRE>
<P>
<!-- .SH DESCRIPTION -->
</BLOCKQUOTE>
<A name=2>

     <H3>DESCRIPTION</H3>

</A>
<BLOCKQUOTE>
Given a preset or native event code,
<!-- .B "PAPI_enum_event()" -->
<B>PAPI_enum_event()</B> replaces the event code with the next available event in either the preset or native table.
The
<!-- .I modifier -->
<I>modifier</I> argument affects which events are returned. For all platforms and event types, a value of
<!-- .B PAPI_ENUM_ALL -->
<B>PAPI_ENUM_ALL</B> (zero) directs the function to return all possible events. For preset events, a
TRUE (non-zero) value currently directs the function to return event codes only for
PAPI preset events available on this platform. This may change in the future.
For native events, the effect of the
<!-- .I modifier  -->
<I>modifier</I> argument is different on each platform. See the discussion below for 
platform-specific definitions.
<P>
<P>
<!-- .SH ARGUMENTS -->
</BLOCKQUOTE>
<A name=3>

     <H3>ARGUMENTS</H3>

</A>
<BLOCKQUOTE>
<!-- .I EventCode -->
<I>EventCode</I> -- a defined preset or native event such as PAPI_TOT_INS.
<!-- .LP -->
<P>
<!-- .I modifier -->
<I>modifier</I> -- modifies the search logic. For preset events, TRUE specifies available events only.
For native events, each platform behaves differently.
See platform-specific documentation for details
<P>
<!-- .SH PENTIUM 4 -->
</BLOCKQUOTE>
<A name=4>

     <H3>PENTIUM 4</H3>

</A>
<BLOCKQUOTE>
The following values are implemented for
<!-- .I modifier -->
<I>modifier</I> on Pentium 4:
<!-- .B "  PAPI_PENT4_ENUM_GROUPS" -->
<B>  PAPI_PENT4_ENUM_GROUPS</B> - 45 groups + custom + user event types
<!-- .B "  PAPI_PENT4_ENUM_COMBOS" -->
<B>  PAPI_PENT4_ENUM_COMBOS</B> - all combinations of mask bits for given group
<!-- .B "  PAPI_PENT4_ENUM_BITS  " -->
<B>  PAPI_PENT4_ENUM_BITS  </B> - all individual bits for a given group
<P>
<!-- .SH ITANIUM -->
</BLOCKQUOTE>
<A name=5>

     <H3>ITANIUM</H3>

</A>
<BLOCKQUOTE>
The following values are implemented for
<!-- .I modifier -->
<I>modifier</I> on Itanium:
<!-- .B "  PAPI_ITA_ENUM_IARR" -->
<B>  PAPI_ITA_ENUM_IARR</B> - Enumerate IAR (instruction address ranging) events
<!-- .B "  PAPI_ITA_ENUM_DARR" -->
<B>  PAPI_ITA_ENUM_DARR</B> - Enumerate DAR (data address ranging) events
<!-- .B "  PAPI_ITA_ENUM_OPCM" -->
<B>  PAPI_ITA_ENUM_OPCM</B> - Enumerate OPC (opcode matching) events
<!-- .B "  PAPI_ITA_ENUM_IEAR" -->
<B>  PAPI_ITA_ENUM_IEAR</B> - Enumerate IEAR (instr event address register) events
<!-- .B "  PAPI_ITA_ENUM_DEAR" -->
<B>  PAPI_ITA_ENUM_DEAR</B> - Enumerate DEAR (data event address register) events
<P>
<!-- .SH POWER 4 -->
</BLOCKQUOTE>
<A name=6>

     <H3>POWER 4</H3>

</A>
<BLOCKQUOTE>
The following values are implemented for
<!-- .I modifier -->
<I>modifier</I> on POWER 4:
<!-- .B "  PAPI_PWR4_ENUM_GROUPS" -->
<B>  PAPI_PWR4_ENUM_GROUPS</B> - Enumerate groups to which an event belongs
<P>
<!-- .SH RETURN VALUES -->
</BLOCKQUOTE>
<A name=7>

     <H3>RETURN VALUES</H3>

</A>
<BLOCKQUOTE>
On success, this function returns
<!-- .B "PAPI_OK" , -->
<B>PAPI_OK ,</B> and on error, a non-zero error code is returned.
<P>
<!-- .SH ERRORS -->
</BLOCKQUOTE>
<A name=8>

     <H3>ERRORS</H3>

</A>
<BLOCKQUOTE>
<!-- .TP -->
<TABLE cellpadding=3>
<TR valign=top><TD colspan=2>
<!-- .B "PAPI_ENOEVNT" -->
<B>PAPI_ENOEVNT</B> </TD></TR><TR valign=top><TD width=6%>&nbsp;</TD><TD>
The next requested PAPI preset or native event is not available on the underlying hardware.
<P>
<!-- .SH EXAMPLES -->
</TD></TR>
<TR></TR></TABLE></BLOCKQUOTE>
<A name=9>

     <H3>EXAMPLES</H3>

</A>
<BLOCKQUOTE>
<!-- .nf -->
<PRE>
<!-- .if t .ft CW -->
<TT>/* Scan for all supported native events on this platform */
<P>
   printf("Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;       Code&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;   Description0);
   do {
         retval = PAPI_get_event_info(i, &info);
         if (retval == PAPI_OK) {
            printf("%-30s 0x%-10x0s0, info.symbol, info.event_code, info.long_descr);
         }
   } while (PAPI_enum_event(&i, PAPI_ENUM_ALL) == PAPI_OK);
<P>
<!-- .if t .ft P -->
</TT><!-- .fi -->
</PRE>
<P>
<!-- .SH BUGS -->
</BLOCKQUOTE>
<A name=10>

     <H3>BUGS</H3>

</A>
<BLOCKQUOTE>
This function has no known bugs.
<P>
<!-- .SH SEE ALSO -->
</BLOCKQUOTE>
<A name=11>

     <H3>SEE ALSO</H3>

</A>
<BLOCKQUOTE>
<!-- .BR PAPI_preset "(3), " PAPI_native "(3), " -->
<A HREF="papi_preset.html">PAPI_preset (3)</A>, 
<A HREF="papi_native.html">PAPI_native (3)</A>, 
<!-- .BR PAPI_get_event_info "(3), " PAPI_event_name_to_code "(3)"  -->
<A HREF="papi_get_event_info.html">PAPI_get_event_info (3)</A>, 
<A HREF="papi_event_name_to_code.html">PAPI_event_name_to_code (3)</A>
<!-- .BR PAPI "(3), " PAPIF "(3)" -->
<A HREF="papi.html">PAPI (3)</A>, 
<A HREF="papif.html">PAPIF (3)</A>
</BLOCKQUOTE>
<P><HR>
<TABLE width=100%><TR> <TD width=33%><I>PAPI Programmer&#146;s Reference</I></TD> <TD width=33% align=center>PAPI_enum_event (3)</TD> <TD align=right width=33%><I>October, 2006</I></TD> </TR></TABLE>
<HR SIZE="1">

</TD>

</TR>

</TABLE>

</TD>

</TR>

<TR>

<TD VALIGN="top">

<TABLE WIDTH="760" BORDER="0" CELLSPACING="0" CELLPADDING="5" ALIGN="center">

<TR>

<TD>

</TD>

</TR>

<TR>

<TD HEIGHT="92">

<TABLE WIDTH="760" BORDER="0" CELLSPACING="0" CELLPADDING="0" ALIGN="center" VSPACE="0" HSPACE="0">

<TR VALIGN="top">

<TD ALIGN="left" BACKGROUND="../images/stripes2.jpg" ROWSPAN="2">&nbsp;

 

</TD>

<TD ALIGN="right" HEIGHT="39" BACKGROUND="../images/stripes2.jpg" WIDTH="280">

<IMG SRC="../images/trans.gif" WIDTH="280" HEIGHT="63" VSPACE="0" HSPACE="0">

</TD>

<TD ALIGN="left" HEIGHT="63" WIDTH="200" BACKGROUND="../images/spinbg.jpg">

<A HREF="http://icl.cs.utk.edu/" ONMOUSEOUT="MM_swapImgRestore()" ONMOUSEOVER="MM_swapImage('Image10','','../images/spinlogo.gif',1)">

<IMG NAME="Image10" BORDER="0" SRC="../images/stable.gif" WIDTH="200" HEIGHT="63" HSPACE="0" VSPACE="0" ALIGN="left" ALT="Innovative Computing Laboratory">

</A>

</TD>

<TD ALIGN="left" HEIGHT="0" ROWSPAN="2" VALIGN="top" WIDTH="140">

<DIV ALIGN="left">

<IMG SRC="../images/trans.gif" WIDTH="140" HEIGHT="75" BORDER="0" ALIGN="left" VSPACE="0" HSPACE="0">

</DIV>

</TD>

<TD ALIGN="left" ROWSPAN="2" VALIGN="top" WIDTH="140">

<IMG SRC="../images/rd.jpg" WIDTH="140" HEIGHT="75" BORDER="0" ALIGN="right" VSPACE="0" HSPACE="0" ALT="2001 R&amp;D Winner">

</TD>

<TD ALIGN="right" ROWSPAN="3" VALIGN="top" BGCOLOR="#FFFFFF">&nbsp;

 

</TD>

</TR>

<TR VALIGN="top">

<TD ALIGN="center" HEIGHT="22" ROWSPAN="2" VALIGN="TOP">

<SPAN CLASS="FOOTERNOTE">

Contact PAPI: 

<A HREF="mailto:papi@cs.utk.edu">

papi@cs.utk.edu</A>

</SPAN>

</TD>

<TD ALIGN="center" HEIGHT="11" WIDTH="200">

<A HREF="http://www.cs.utk.edu/" ONMOUSEOUT="MM_swapImgRestore()" ONMOUSEOVER="MM_swapImage('Image11','','../images/cssigon.gif',1)">

<IMG NAME="Image11" BORDER="0" SRC="../images/cssigoff.gif" WIDTH="200" HEIGHT="11" ALIGN="left" HSPACE="0" VSPACE="0" ALT="Computer Science Department">

</A>

</TD>

</TR>

<TR VALIGN="top">

<TD ALIGN="left">&nbsp;

 

</TD>

<TD ALIGN="CENTER" HEIGHT="11" WIDTH="200" VALIGN="top">

<A HREF="http://www.utk.edu/" ONMOUSEOUT="MM_swapImgRestore()" ONMOUSEOVER="MM_swapImage('Image12','','../images/utsigon.gif',1)">

<IMG NAME="Image12" BORDER="0" SRC="../images/utsigoff.gif" WIDTH="200" HEIGHT="11" VSPACE="0" HSPACE="0" ALIGN="left" ALT="University of Tennessee">

</A>

</TD>

<TD ALIGN="left" HEIGHT="0" COLSPAN="2" VALIGN="top">&nbsp;

 

</TD>

</TR>

</TABLE>

</TD>

</TR>

</TABLE>

</TD>

</TR>

<TR>

<TD VALIGN="top">&nbsp;

 

</TD>

</TR>

</TABLE>

</BODY>

</HTML>

